Documentation for the python Generator
METADATA
| Property | Value | Notes |
|---|---|---|
| generator name | python | pass this to the generate command after -g |
| generator stability | STABLE | |
| generator type | CLIENT | |
| generator language | Python | |
| generator language version | 3.10+ | |
| generator default templating engine | mustache | |
| helpTxt | Generates a Python client library. |
CONFIG OPTIONS
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.
| Option | Description | Values | Default |
|---|---|---|---|
| buildSystem | Build system to use in pyproject.toml (setuptools, hatchling). | setuptools | |
| compatibleWithPythonLegacy | Enable compatibility with python-legacy. Currently, generated model field aliases preserve normalized Python constructor names while accepting wire names, and to_dict() emits every declared field, using None for missing attributes, under public names by default and wire names with serialize=True. Generic models expose openapi_types and attribute_map, reject unknown constructor keys, and use legacy display and equality helpers. Container conversion is limited to immediate list elements and dictionary values, matching python-legacy. Synchronous urllib3 operations keep async_req, _preload_content, tuple with_http_info() behavior, and integer _request_timeout inputs. JSON and request serialization remain unchanged. | false | |
| dateFormat | date format for query parameters | %Y-%m-%d | |
| datetimeFormat | datetime format for query parameters | %Y-%m-%dT%H:%M:%S%z | |
| disallowAdditionalPropertiesIfNotPresent | If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default. |
| true |
| generateSourceCodeOnly | Specifies that only a library source code is to be generated. | false | |
| hideGenerationTimestamp | Hides the generation timestamp when files are generated. | true | |
| lazyImports | Enable lazy imports. | false | |
| library | library template (sub-template) to use: asyncio, urllib3, httpx, httpx2 | urllib3 | |
| mapNumberTo | Map number to Union[StrictFloat, StrictInt], StrictFloat, float or Decimal. | Union[StrictFloat, StrictInt] | |
| packageName | python package name (convention: snake_case). | openapi_client | |
| packageUrl | python package URL. | null | |
| packageVersion | python package version. | 1.0.0 | |
| poetry1 | Fallback to formatting pyproject.toml to Poetry 1.x format. | null | |
| projectName | python project name in setup.py (e.g. petstore-api). | null | |
| recursionLimit | Set the recursion limit. If not set, use the system default value. | null | |
| setEnsureAsciiToFalse | When set to true, add ensure_ascii=False in json.dumps when creating the HTTP request body. | false | |
| supportHttpxSync | Generate synchronous '_sync' variants of each API method (httpx and httpx2 libraries only). Each '_sync' method simply calls the corresponding async method and waits for its completion, so both synchronous and asynchronous methods are available from the same API class. | false | |
| useIndependentImplicitClients | Give API instances without an explicit or registered default ApiClient an owned client with a copied Configuration. | false | |
| useOneOfDiscriminatorLookup | Use the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and only one match in oneOf's schemas) will be skipped. | false |
IMPORT MAPPING
| Type/Alias | Imports |
|---|
INSTANTIATION TYPES
| Type/Alias | Instantiated By |
|---|
LANGUAGE PRIMITIVES
- Dict
- List
- UUID
- bool
- bytes
- date
- datetime
- decimal.Decimal
- dict
- float
- int
- list
- none_type
- object
- str
RESERVED WORDS
- all_params
- and
- as
- assert
- async
- auth_settings
- await
- base64
- body_params
- break
- class
- continue
- date
- def
- del
- elif
- else
- except
- exec
- false
- field
- finally
- float
- for
- form_params
- from
- from_dict
- from_json
- global
- header_params
- if
- import
- in
- is
- json
- lambda
- local_var_files
- model_computed_fields
- model_config
- model_construct
- model_copy
- model_dump
- model_dump_json
- model_extra
- model_fields
- model_fields_set
- model_json_schema
- model_parametrized_name
- model_post_init
- model_rebuild
- model_validate
- model_validate_json
- model_validate_strings
- none
- nonlocal
- not
- or
- pass
- path_params
- property
- query_params
- raise
- resource_path
- return
- schema
- self
- to_dict
- to_json
- to_str
- true
- try
- while
- with
- yield
FEATURE SET
Client Modification Feature
| Name | Supported | Defined By |
|---|---|---|
| BasePath | ✗ | ToolingExtension |
| Authorizations | ✗ | ToolingExtension |
| UserAgent | ✗ | ToolingExtension |
| MockServer | ✗ | ToolingExtension |
Data Type Feature
| Name | Supported | Defined By |
|---|---|---|
| Custom | ✗ | OAS2,OAS3 |
| Int32 | ✓ | OAS2,OAS3 |
| Int64 | ✓ | OAS2,OAS3 |
| Float | ✓ | OAS2,OAS3 |
| Double | ✓ | OAS2,OAS3 |
| Decimal | ✓ | ToolingExtension |
| String | ✓ | OAS2,OAS3 |
| Byte | ✓ | OAS2,OAS3 |
| Binary | ✓ | OAS2,OAS3 |
| Boolean | ✓ | OAS2,OAS3 |
| Date | ✓ | OAS2,OAS3 |
| DateTime | ✓ | OAS2,OAS3 |
| Password | ✓ | OAS2,OAS3 |
| File | ✓ | OAS2 |
| Uuid | ✓ | |
| Array | ✓ | OAS2,OAS3 |
| Null | ✗ | OAS3 |
| AnyType | ✗ | OAS2,OAS3 |
| Object | ✓ | OAS2,OAS3 |
| Maps | ✓ | ToolingExtension |
| CollectionFormat | ✓ | OAS2 |
| CollectionFormatMulti | ✓ | OAS2 |
| Enum | ✓ | OAS2,OAS3 |
| ArrayOfEnum | ✓ | ToolingExtension |
| ArrayOfModel | ✓ | ToolingExtension |
| ArrayOfCollectionOfPrimitives | ✓ | ToolingExtension |
| ArrayOfCollectionOfModel | ✓ | ToolingExtension |
| ArrayOfCollectionOfEnum | ✓ | ToolingExtension |
| MapOfEnum | ✓ | ToolingExtension |
| MapOfModel | ✓ | ToolingExtension |
| MapOfCollectionOfPrimitives | ✓ | ToolingExtension |
| MapOfCollectionOfModel | ✓ | ToolingExtension |
| MapOfCollectionOfEnum | ✓ | ToolingExtension |
Documentation Feature
| Name | Supported | Defined By |
|---|---|---|
| Readme | ✓ | ToolingExtension |
| Model | ✓ | ToolingExtension |
| Api | ✓ | ToolingExtension |
Global Feature
| Name | Supported | Defined By |
|---|---|---|
| Host | ✓ | OAS2,OAS3 |
| BasePath | ✓ | OAS2,OAS3 |
| Info | ✓ | OAS2,OAS3 |
| Schemes | ✗ | OAS2,OAS3 |
| PartialSchemes | ✓ | OAS2,OAS3 |
| Consumes | ✓ | OAS2 |
| Produces | ✓ | OAS2 |
| ExternalDocumentation | ✓ | OAS2,OAS3 |
| Examples | ✓ | OAS2,OAS3 |
| XMLStructureDefinitions | ✗ | OAS2,OAS3 |
| MultiServer | ✗ | OAS3 |
| ParameterizedServer | ✗ | OAS3 |
| ParameterStyling | ✗ | OAS3 |
| Callbacks | ✗ | OAS3 |
| LinkObjects | ✗ | OAS3 |
Parameter Feature
| Name | Supported | Defined By |
|---|---|---|
| Path | ✓ | OAS2,OAS3 |
| Query | ✓ | OAS2,OAS3 |
| Header | ✓ | OAS2,OAS3 |
| Body | ✓ | OAS2 |
| FormUnencoded | ✓ | OAS2 |
| FormMultipart | ✓ | OAS2 |
| Cookie | ✗ | OAS3 |
Schema Support Feature
| Name | Supported | Defined By |
|---|---|---|
| Simple | ✓ | OAS2,OAS3 |
| Composite | ✓ | OAS2,OAS3 |
| Polymorphism | ✓ | OAS2,OAS3 |
| Union | ✗ | OAS3 |
| allOf | ✓ | OAS2,OAS3 |
| anyOf | ✓ | OAS3 |
| oneOf | ✓ | OAS3 |
| not | ✗ | OAS3 |
Security Feature
| Name | Supported | Defined By |
|---|---|---|
| BasicAuth | ✓ | OAS2,OAS3 |
| ApiKey | ✓ | OAS2,OAS3 |
| OpenIDConnect | ✗ | OAS3 |
| BearerToken | ✓ | OAS3 |
| OAuth2_Implicit | ✓ | OAS2,OAS3 |
| OAuth2_Password | ✗ | OAS2,OAS3 |
| OAuth2_ClientCredentials | ✗ | OAS2,OAS3 |
| OAuth2_AuthorizationCode | ✗ | OAS2,OAS3 |
| SignatureAuth | ✓ | OAS3 |
| AWSV4Signature | ✗ | ToolingExtension |
Wire Format Feature
| Name | Supported | Defined By |
|---|---|---|
| JSON | ✓ | OAS2,OAS3 |
| XML | ✓ | OAS2,OAS3 |
| PROTOBUF | ✗ | ToolingExtension |
| Custom | ✓ | OAS2,OAS3 |