Skip to content

Commit 2a39b29

Browse files
authored
[python] Add field as a reserved word (OpenAPITools#18279)
* add field as a reserved word * remove tabs * update
1 parent 88204b2 commit 2a39b29

34 files changed

Lines changed: 692 additions & 0 deletions

File tree

docs/generators/python-aiohttp.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
9191
<li>except</li>
9292
<li>exec</li>
9393
<li>false</li>
94+
<li>field</li>
9495
<li>finally</li>
9596
<li>float</li>
9697
<li>for</li>

docs/generators/python-blueplanet.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
9191
<li>except</li>
9292
<li>exec</li>
9393
<li>false</li>
94+
<li>field</li>
9495
<li>finally</li>
9596
<li>float</li>
9697
<li>for</li>

docs/generators/python-flask.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
9191
<li>except</li>
9292
<li>exec</li>
9393
<li>false</li>
94+
<li>field</li>
9495
<li>finally</li>
9596
<li>float</li>
9697
<li>for</li>

docs/generators/python.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
8888
<li>except</li>
8989
<li>exec</li>
9090
<li>false</li>
91+
<li>field</li>
9192
<li>finally</li>
9293
<li>float</li>
9394
<li>for</li>

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPythonCodegen.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@ public AbstractPythonCodegen() {
105105
// from https://docs.python.org/3/reference/lexical_analysis.html#keywords
106106
setReservedWordsLowerCase(
107107
Arrays.asList(
108+
// pydantic
109+
"field",
108110
// local variable name used in API methods (endpoints)
109111
"all_params", "resource_path", "path_params", "query_params",
110112
"header_params", "form_params", "local_var_files", "body_params", "auth_settings",

modules/openapi-generator/src/test/resources/3_0/python/petstore-with-fake-endpoints-models-for-testing.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2706,3 +2706,8 @@ components:
27062706
type: array
27072707
items:
27082708
$ref: "#/components/schemas/CreatureInfo"
2709+
field:
2710+
type: object
2711+
properties:
2712+
field:
2713+
type: string

samples/openapi3/client/petstore/python-aiohttp/.openapi-generator/FILES

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ docs/MapTest.md
6060
docs/MixedPropertiesAndAdditionalPropertiesClass.md
6161
docs/Model200Response.md
6262
docs/ModelApiResponse.md
63+
docs/ModelField.md
6364
docs/ModelReturn.md
6465
docs/Name.md
6566
docs/NullableClass.md
@@ -172,6 +173,7 @@ petstore_api/models/map_test.py
172173
petstore_api/models/mixed_properties_and_additional_properties_class.py
173174
petstore_api/models/model200_response.py
174175
petstore_api/models/model_api_response.py
176+
petstore_api/models/model_field.py
175177
petstore_api/models/model_return.py
176178
petstore_api/models/name.py
177179
petstore_api/models/nullable_class.py

samples/openapi3/client/petstore/python-aiohttp/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,7 @@ Class | Method | HTTP request | Description
202202
- [MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md)
203203
- [Model200Response](docs/Model200Response.md)
204204
- [ModelApiResponse](docs/ModelApiResponse.md)
205+
- [ModelField](docs/ModelField.md)
205206
- [ModelReturn](docs/ModelReturn.md)
206207
- [Name](docs/Name.md)
207208
- [NullableClass](docs/NullableClass.md)
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# ModelField
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**var_field** | **str** | | [optional]
9+
10+
## Example
11+
12+
```python
13+
from petstore_api.models.model_field import ModelField
14+
15+
# TODO update the JSON string below
16+
json = "{}"
17+
# create an instance of ModelField from a JSON string
18+
model_field_instance = ModelField.from_json(json)
19+
# print the JSON string representation of the object
20+
print(ModelField.to_json())
21+
22+
# convert the object into a dict
23+
model_field_dict = model_field_instance.to_dict()
24+
# create an instance of ModelField from a dict
25+
model_field_form_dict = model_field.from_dict(model_field_dict)
26+
```
27+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28+
29+

samples/openapi3/client/petstore/python-aiohttp/petstore_api/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@
9191
from petstore_api.models.mixed_properties_and_additional_properties_class import MixedPropertiesAndAdditionalPropertiesClass
9292
from petstore_api.models.model200_response import Model200Response
9393
from petstore_api.models.model_api_response import ModelApiResponse
94+
from petstore_api.models.model_field import ModelField
9495
from petstore_api.models.model_return import ModelReturn
9596
from petstore_api.models.name import Name
9697
from petstore_api.models.nullable_class import NullableClass

0 commit comments

Comments
 (0)