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

[python-flask] Fix NoneType when deserialize optional date #10081

Merged
merged 2 commits into from
Aug 14, 2021

Conversation

LeComptoirDesPharmacies
Copy link
Contributor

@LeComptoirDesPharmacies LeComptoirDesPharmacies commented Aug 2, 2021

What have been done

As "deserialize_date" and "deserialize_datetime" are used outside of "deserialize_model", we should check 'None' value before parsing string.

To close #5813

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 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master, 5.3.x, 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Verify that it works

  1. Generate a server : (Yaml file below)
    java -jar openapi-generator-cli/target/openapi-generator-cli.jar generate -i openapi.yaml -g python-flask -o ./server/generated/

  2. Run :
    python3 -m openapi_server

  3. Go to URL :
    Use Postman to "GET /events"

Without this fix :

[2021-08-02 17:41:35,566] ERROR in app: Exception on /events [GET]
[...]
TypeError: Parser must be a string or character stream, not NoneType

With this fix :
127.0.0.1 - - [02/Aug/2021 17:41:13] "GET /events HTTP/1.1" 200 -

openapi: "3.0.0"
info:
  version: 1.0.0
  title: OpenApi Petstore
  license:
    name: MIT
paths:
  /events:
    get:
      summary: "Get a list of all events"
      operationId: listEvents
      parameters:
        - $ref: '#/components/parameters/startDateParam'
      responses:
        '200':
          description: A paged array of pets
        
components:
  parameters:
    startDateParam:
      name: startDate
      in: query
      description: Optional start date when querying date based items
      required: false
      schema:
        type: string
        format: date

@taxpon (2017/07) @frol (2017/07) @mbohlool (2017/07) @cbornet (2017/09) @kenjones-cisco (2017/11) @tomplus (2018/10) @Jyhess (2019/01) @arun-nalla (2019/11) @spacether (2019/11)

As "deserialize_date" and "deserialize_datetime" are used outside of "deserialize_model", we should check 'None' value before parsing string.
Update samples and docs
@wing328
Copy link
Member

wing328 commented Aug 14, 2021

Local tests look good

============== 11 passed, 9 skipped, 15 warnings in 8.36 seconds ===============
___________________________________ summary ____________________________________
  py3: commands succeeded
  congratulations :)

@wing328 wing328 merged commit 7d35e8d into OpenAPITools:master Aug 14, 2021
@wing328 wing328 changed the title [python-flask] Fix NoneType when deserialize optional date (See #5813) [python-flask] Fix NoneType when deserialize optional date Aug 14, 2021
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.

[BUG] [flask-python] Optional date in query parameters results in dateutil error when None
3 participants