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] Update docs/ Markdown files for Classes to fix _form_ typo and correct casing for class name when calling from_dict() #18359

Merged

Conversation

kdipippo
Copy link
Contributor

@kdipippo kdipippo commented Apr 11, 2024

All changes contained in 5385bcb
This only affects docs/ markdown files, so this is not a breaking change.


In the Python generated docs (for all three generators python, python-fastapi, and python-pydantic-v1), below is an example of what gets formed for the example snippet:

from openapi_client.models.dog_model import DogModel

# TODO update the JSON string below
json = "{}"
# create an instance of DogModel from a JSON string
dog_model_instance = DogModel.from_json(json)
# print the JSON string representation of the object
print(DogModel.to_json()) 

# convert the object into a dict
dog_model_dict = dog_model_instance.to_dict()
# create an instance of DogModel from a dict
dog_model_form_dict = dog_model.from_dict(dog_model_dict)  # <-- THIS LINE

Hovering over dog_model in the last row shows the error "dog_model" is not defined. The snippet works as expected if dog_model is instead DogModel, so that from_dict() is called against an empty object.

This also additionally changes dog_model_form_dict to dog_model_from_dict to match the method from_dict().

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/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (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.1.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.

Python Technical Committee

@cbornet (2017/09) @tomplus (2018/10) @krjakbrjak (2023/02) @fa0311 (2023/10) @multani (2023/10)

@kdipippo kdipippo changed the title Update Python mustache templates to fix _form_ typo and correct casing for class name when calling from_dict() [python][python-fastapi][python-pydantic-v1] Update docs/ Markdown files for Classes to fix _form_ typo and correct casing for class name when calling from_dict() Apr 11, 2024
@kdipippo kdipippo changed the title [python][python-fastapi][python-pydantic-v1] Update docs/ Markdown files for Classes to fix _form_ typo and correct casing for class name when calling from_dict() [python] Update docs/ Markdown files for Classes to fix _form_ typo and correct casing for class name when calling from_dict() Apr 11, 2024
@kdipippo kdipippo marked this pull request as ready for review April 11, 2024 18:26
Copy link
Contributor

@fa0311 fa0311 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@wing328 wing328 merged commit 0b3e6ed into OpenAPITools:master Apr 12, 2024
49 checks passed
@wing328 wing328 added this to the 7.5.0 milestone Apr 12, 2024
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

3 participants