add more information to resolved TypedDicts

[JoshFerge]

• on py 3.9 and above, use the __required_keys__ field to annotate TypedDict values with required keys
• Add a description via the hint's __doc__ attribute if it exists

This would be a breaking change resulting in different OpenAPI schema if end-users didn't mark their TypedDicts with total=False on 3.9 and above, as previously, all TypedDict fields were optional.

[codecov]

Codecov Report

Merging #654 (7da9abf) into master (27ac1ca) will decrease coverage by 0.39%.
The diff coverage is 38.88%.

@@            Coverage Diff             @@
##           master     #654      +/-   ##
==========================================
- Coverage   98.80%   98.40%   -0.40%     
==========================================
  Files          63       63              
  Lines        7005     6767     -238     
==========================================
- Hits         6921     6659     -262     
- Misses         84      108      +24     

Impacted Files	Coverage Δ
tests/test_plumbing.py	88.13% <16.66%> (-11.87%)	⬇️
drf_spectacular/plumbing.py	96.43% <83.33%> (-1.15%)	⬇️
drf_spectacular/helpers.py	83.33% <0.00%> (-1.67%)	⬇️
drf_spectacular/drainage.py	97.67% <0.00%> (-1.21%)	⬇️
drf_spectacular/checks.py	77.77% <0.00%> (-1.17%)	⬇️
tests/test_fields.py	99.45% <0.00%> (-0.55%)	⬇️
drf_spectacular/contrib/rest_auth.py	94.59% <0.00%> (-0.35%)	⬇️
tests/conftest.py	97.72% <0.00%> (-0.15%)	⬇️
... and 34 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 27ac1ca...7da9abf. Read the comment docs.

[tfranzel]

Hey @JoshFerge, thanks for the PR. excellent stuff!

the breakage is fine i think because it's the correct thing to do. i suppose it would have broken anyway if someone would have used the constructor init with missing arguments (TD1(**data)), right?

LGTM with the doc retrieval change

[JoshFerge]

Hey @JoshFerge, thanks for the PR. excellent stuff!

the breakage is fine i think because it's the correct thing to do. i suppose it would have broken anyway if someone would have used the constructor init with missing arguments (TD1(**data)), right?

LGTM with the doc retrieval change

Yep, exactly

[JoshFerge]

i'm going to do some quick testing sometime this week to see if it just works with the typing_extension TypedDict as well (what we're using since we're not on 3.9 yet), in which case we can simply check the hint for the __required_keys__ attribute.

[tfranzel]

Hey, I fixed the call and found a issue with this new case in getdoc. fixed it and merged the PR. let me know if this works for you.

[JoshFerge]

Hey, I fixed the call and found a issue with this new case in getdoc. fixed it and merged the PR. let me know if this works for you.

Yup! Thanks!