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

Fix single quote escaping for python code generator (and its test) #21021

Merged

Conversation

curdbecker
Copy link
Contributor

@curdbecker curdbecker commented Apr 2, 2025

Currently, the implementation of the code generator for Python can generate invalid Python code if single quotes are used within an OpenAPI specification, e.g. for default values. Please see also this issue that I have created.

This stems from invalid single quote escaping within the generator. It's kind of hard to spot, but in Java the strings "'" and "'" are identical, so the implementation and its test were broken identically.

This seems to have happened already quite a few years ago during refactoring, since the test seems might have been created as a result of this issue.

The minimal example from there is still valid:

OpenAPI declaration file content or url
openapi: 3.0.0
info:
  title: Single quote example
  version: 1.0.0
paths:
  /singleQuoteExample:
    post:
      summary: Test single quote in default and example values.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                singleQuoteInDefault1:
                  type: string
                  default: Text containing 'single' quote
                singleQuoteInDefault2:
                  type: string
                  default: "8'998'999'998'000'000"
                singleQuoteInExample1:
                  type: string
                  example: "Text containing 'single' quote"
                singleQuoteInExample2:
                  type: string
                  example: 8'998'999'998'000'000
      responses:
        '201':
          description: OK
Command line used for generation

docker run --rm -v $(pwd)/bla:/bla -v $(pwd):/local openapitools/openapi-generator-cli:latest generate -i /local/bla.yaml -g python -o /bla

Steps to reproduce

Run the above command.

Expected output

bla/openapi_client/models/single_quote_example_post_request.py

class SingleQuoteExamplePostRequest(BaseModel):
    """
    SingleQuoteExamplePostRequest
    """ # noqa: E501
    single_quote_in_default1: Optional[StrictStr] = Field(default='Text containing \'single\' quote', alias="singleQuoteInDefault1")
    single_quote_in_default2: Optional[StrictStr] = Field(default='8\'998\'999\'998\'000\'000', alias="singleQuoteInDefault2")
    single_quote_in_example1: Optional[StrictStr] = Field(default=None, alias="singleQuoteInExample1")
    single_quote_in_example2: Optional[StrictStr] = Field(default=None, alias="singleQuoteInExample2")
    __properties: ClassVar[List[str]] = ["singleQuoteInDefault1", "singleQuoteInDefault2", "singleQuoteInExample1", "singleQuoteInExample2"]
Actual output

bla/openapi_client/models/single_quote_example_post_request.py

class SingleQuoteExamplePostRequest(BaseModel):
    """
    SingleQuoteExamplePostRequest
    """ # noqa: E501
    single_quote_in_default1: Optional[StrictStr] = Field(default='Text containing 'single' quote', alias="singleQuoteInDefault1")
    single_quote_in_default2: Optional[StrictStr] = Field(default='8'998'999'998'000'000', alias="singleQuoteInDefault2")
    single_quote_in_example1: Optional[StrictStr] = Field(default=None, alias="singleQuoteInExample1")
    single_quote_in_example2: Optional[StrictStr] = Field(default=None, alias="singleQuoteInExample2")
    __properties: ClassVar[List[str]] = ["singleQuoteInDefault1", "singleQuoteInDefault2", "singleQuoteInExample1", "singleQuoteInExample2"]

@cbornet @tomplus @krjakbrjak @fa0311 @multani

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in Git BASH)
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.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.

Sorry, something went wrong.

Hard to spot, but in Java the strings "'" and "\'" are identical, so
the implementation and its test were broken identically.
@wing328 wing328 merged commit 7a3ea28 into OpenAPITools:master Apr 7, 2025
14 checks passed
@wing328 wing328 added this to the 7.13.0 milestone Apr 7, 2025
@wing328
Copy link
Member

wing328 commented Apr 7, 2025

thanks for the PR, which has been merged

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

Successfully merging this pull request may close these issues.

None yet

2 participants