Skip to content
GitLab

Adds primitive base classes

Closed Administrator requested to merge github/fork/spacether/adds_primitive_base_classes into master

Created by: spacether

This is the first step to using dynamic base classes in the python-experimental client In this PR I:

  • store enum models in an Enum class
  • other non object models inherit from the expected base class (str, int, etc) unless they are nullable
  • nullable non-object models will return a dynamic base class of Enum type where the name is NONE and the value is None
    • the same tactic will be used for True and False booleans
    • this is done because None. True, and False cannot be inherited from BUT we can make enums that contain them
    • our enum class can will contain a base class like NullableString which allows us to check for this type when sending None/True/False values to the server

Long Term Benefits of Using Dynamic Base Classes

  • This will save us from traversing composed schema relationship trees to figure out if NullableString/XSchema is allowed to contain None/True/False/some other primitive type
  • This supports complicated use cases like allOf -OneOfComposedSchema. OneOfComposedSchema oneOf: -schemaA -schemaB
  • We can reduce the number of times that validations and type conversion are done
    • once to make the dynamic class from a payload, then skip it when assigning object values at init time
    • no need to run this code again when sending an instance of NullableString to the server

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.
  • If contributing template-only or documentation-only changes which will change sample output, build the project beforehand.
  • Run the shell script ./bin/generate-samples.shto update all Petstore samples related to your fix. 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
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.