Skip to content
GitLab
    • Explore Projects Groups Snippets
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !13271
An error occurred while fetching the assigned milestone of the selected merge_request.

[python-experimental] improves type hints

  • Review changes

  • Download
  • Email patches
  • Plain diff
Administrator requested to merge github/fork/spacether/python_exp_improve_type_hints into master 2 years ago
  • Overview 1
  • Commits 22
  • Pipelines 0
  • Changes 448

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.
Loading
Loading

Activity


  • Administrator changed title from [python-experimental] improve type hints to [python-experimental] improves type hints 2 years ago

    changed title from [python-experimental] improve type hints to [python-experimental] improves type hints

  • Administrator added Client: Python label 2 years ago

    added Client: Python label

  • Administrator changed milestone to %6.1.0 2 years ago

    changed milestone to %6.1.0

  • Administrator
    Administrator @root · 2 years ago
    Author Contributor

    Merged by: spacether at 2022-08-26 14:09:08 UTC

  • Administrator closed 2 years ago

    closed

  • Administrator mentioned in issue #13324 (closed) 2 years ago

    mentioned in issue #13324 (closed)

Please register or sign in to reply
0 Assignees
None
Assign to
0 Reviewers
None
Request review from
Labels
0
None
0
None
    Assign labels
  • Manage project labels

Milestone
No milestone
None
None
Time tracking
No estimate or time spent
Lock merge request
Unlocked
1
1 participant
Administrator
Reference:
Source branch: github/fork/spacether/python_exp_improve_type_hints

Menu

Explore Projects Groups Snippets