Skip to content
GitLab

[python-experimental] improves type hints

Merged Administrator requested to merge github/fork/spacether/python_exp_improve_type_hints into master

Created by: spacether

improves type hints

  • dict property type hints added to the cls level
  • XSchema(X=List/Str/Bool/Dict/None/Number) classes now have mixed in base classes so pycharm can see their types
  • properties, additional_properties, discriminator, required, and items moved into the MetaOapg class
    • this was done so all schema info will be in the MetaOapg class
    • also it eliminates the need for underscore prefixes on class variables
  • type hints improved in Model new signature, python primitive types added (int/float/None/dict/list/str... etc)
  • type hints improved in endpoint signature, python primitive types added (int/float/None/dict/list/str... etc)

Not yet covered / future work

  • optional properties may not be present in dicts/model instances, so when they are accessed an error will be thrown
  • the type hint does not indicate this, changing behavior to return unset in that case is a better solution because then the type hint would describe what could be returned
  • add type array/nullable mixins
  • add primitive type hint info in new and endpoint $ref inputs
  • add invalidly named schemas into the **kwargs type hint
  • add new signature for array models to show inputs and returned type

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
    Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./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.