Created by: spacether
for optional object properties, adds schemas.Unset type hints
Note: If one wanted to make the get_item type hints work better, one could define an enum for the field names Then the field names would be
- name: FieldName(Enum) when they exist in properties
- name: str for additionalProperties
And with that, the overloading will work correctly. Right now it is not working right for some_dict["someProp"] because when someProp exists and is a string literal, that literal is also type string, so it also matches with the str (additionalProperties) type hint.
Question: do pycharm and vscode see field_name = FieldName("someField") as the correct enum value type? If not then one may be able to add a type hint showing that.
PR checklist
-
Read the contribution guidelines. -
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community. -
Run the following to build the project and update samples: ./mvnw clean package ./bin/generate-samples.sh ./bin/utils/export_docs_generators.sh
./bin/generate-samples.sh bin/configs/java*
. For Windows users, please run the script in Git BASH. -
File the PR against the correct branch: master
(6.1.0) (minor release - breaking changes with fallbacks),7.0.x
(breaking changes without fallbacks) -
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.