Skip to content
GitLab

python-experimental adds dynamic base classes [DRAFT]

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

Created by: spacether

python-experimental adds dynamic base classes

In this PR:

  • when deserializing payloads or creating Schema/Model instances the new instance will dynamically inherit from the correct Schema classes (models) and python primitive classes (dict, str, list, int, float, etc)

So an object model Box will inherit from Box, Schema, and dict. Caviats:

  • None, True, and False are singletons in python so we can't inherit from them
    • For those cases, we return an enum option with the below NAME and value
      • NONE = None
      • TRUE = True
      • FALSE = False This allows our None/True/False use cases to still identify themselves as a Model/Schema and contain the expected values

For a composed schema Triangle that oneOf includes ScaleneTriangle, the resulting instance will inherit from Triangle + ScaleneTriangle

Long Term Benefits of Using Dynamic Base Classes

  • any depth of inline models can be supported
  • model definition is shorter
  • 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
  • when one has an instance of a composed schema, one will know what schemas passed validation for that payload

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.