python: type generated client using Self #16693
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This doesn't offer a clear win but this helps for: * Using modern types and making the typing intent clearer * Decreasing the need for `from __future__ import annotations`, since a class can now refer to itself without using its name * Using more `cls` to automatically refer to the class, instead of respecifying the class name every time Self is available from Python 3.11 and is provided in typing_extensions (since 4.0.0) as a fallback for older versions See: https://peps.python.org/pep-0673/ See: https://github.com/python/typing_extensions/blob/main/CHANGELOG.md#added-in-version-400
|
can you please resolve conflicts when you've time? |
multani
commented
Oct 1, 2023
| @@ -12,6 +12,11 @@ import json | |||
| {{#vendorExtensions.x-py-model-imports}} | |||
| {{{.}}} | |||
| {{/vendorExtensions.x-py-model-imports}} | |||
| from typing import Dict, Any | |||
There was a problem hiding this comment.
This was missing for additional_properties below.
wing328
reviewed
Oct 1, 2023
modules/openapi-generator/src/main/resources/python/model_anyof.mustache
Show resolved
Hide resolved
AlanCitrix
pushed a commit
to AlanCitrix/openapi-generator
that referenced
this pull request
Oct 26, 2023
* python: type generated client using Self This doesn't offer a clear win but this helps for: * Using modern types and making the typing intent clearer * Decreasing the need for `from __future__ import annotations`, since a class can now refer to itself without using its name * Using more `cls` to automatically refer to the class, instead of respecifying the class name every time Self is available from Python 3.11 and is provided in typing_extensions (since 4.0.0) as a fallback for older versions See: https://peps.python.org/pep-0673/ See: https://github.com/python/typing_extensions/blob/main/CHANGELOG.md#added-in-version-400 * generate code
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This doesn't offer a major win but this helps for:
clsto automatically refer to the class, instead of re-specifying the class name every timefrom __future__ import annotations, since a class can now refer to itself without using its nameIn itself, this doesn't change the type coverage.
Selfis available from Python 3.11 and is provided in typing_extensions (since 4.0.0) as a fallback for older versionsSee: https://peps.python.org/pep-0673/
See: https://github.com/python/typing_extensions/blob/main/CHANGELOG.md#added-in-version-400
@wing328
@krjakbrjak
@fa0311
PR checklist
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.
master(upcoming 7.1.0 minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)