Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG][PYTHON] Generated python-flask server stub enum strings don't have quotes #13689

Open
5 of 6 tasks
renxinhe opened this issue Oct 14, 2022 · 1 comment
Open
5 of 6 tasks

Comments

@renxinhe
Copy link

renxinhe commented Oct 14, 2022

Bug Report Checklist

  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

Generated python server stub doesn't have quotes around the enum values. This generates python code with syntax errors.

OpenAPI 3.0 YAML input:

status:
    type: string
    description: status
    enum:
      - local
      - invited
      - accepted
      - confirmed
      - rejected

Generated python model stub code:

    @status.setter
    def status(self, status):
        """<omitted>
        """
        allowed_values = [None,local, invited, accepted, confirmed, rejected]  # noqa: E501
        if status not in allowed_values:
            raise ValueError(
                "Invalid value for `status` ({0}), must be one of {1}"
                .format(status, allowed_values)
            )

        self._status = status

Notice that the line allowed_values = ... isn't valid python code. The enum values need to be surrounded by quotes because they are string types.

openapi-generator version

6.2.0

OpenAPI declaration file content or url
status:
    type: string
    description: status
    enum:
      - local
      - invited
      - accepted
      - confirmed
      - rejected
Generation Details
 java -jar openapi-generator-cli.jar generate -g python-flask -i '/tmp/api.yaml' -o '/tmp/codegen_test'
Steps to reproduce

Simply run the codegen CLI and check the output file to see the missing quotes in the stub.

Related issues/PRs

This issue is similar to #3196, but the opposite direction. Here we have manually defined an OpenAPI 3.0 YAML, and want to generate python server stub.

Suggest a fix

I'd imagine this bug is specific to the python flask server generator. I'm not too familiar with the code base to navigate to the culprit.

@OJFord
Copy link
Contributor

OJFord commented Nov 4, 2022

This seems to be a regression in 6.1.0, downgrade to 6.0.0 to work around.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants