Skip to content
GitLab

[python-experimental] Allow models to have properties of type self

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

Created by: spacether

This updates the python-experimental generator to allow a model to have properties of type self. An example model is a Player which stores an enemyPlayer also of type player.

See this use case example:

  Player:
    type: object
    required:
      - name
    properties:
      name:
        type: string
      enemyPlayer:
        type: object
        $ref: '#/components/schemas/Player'

And our python code demonstrating that it works:

        jim = petstore_api.Player(
            name="Jim",
            enemy_player=petstore_api.Player(name="Sam")
        )

This was fixed by converting class.openapi_types into a class method, which prevents the openapi_types code from being run at import time. We also removed the module name from the dataType of the property if the property in self's model.

Test Verification

A test has been added demonstrating that this works at https://github.com/spacether/openapi-generator/blob/issue_4885_allow_self_properties/samples/client/petstore/python-experimental/test/test_player.py#L32

If merged, this will resolve: https://github.com/OpenAPITools/openapi-generator/issues/4885

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

Python technical-committee: @taxpon (2017/07) @frol (2017/07) @mbohlool (2017/07) @cbornet (2017/09) @kenjones-cisco (2017/11) @tomplus (2018/10) @Jyhess (2019/01) @slash-arun (2019/11) @spacether (2019/11)

@ethan92429