Skip to content

Latest commit

 

History

History
310 lines (284 loc) · 9.26 KB

python.md

File metadata and controls

310 lines (284 loc) · 9.26 KB
Raw
title
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.8
generator default templating engine handlebars
helpMsg Generates a Python client library

Features in this generator:
- type hints on endpoints and model creation
- model parameter names use the spec defined keys and cases
- robust composition (oneOf/anyOf/allOf/not) where payload data is stored in one instance only
- endpoint parameter names use the spec defined keys and cases
- inline schemas are supported at any location including composition
- multiple content types supported in request body and response bodies
- run time type checking + json schema validation
- json schema keyword validation may be selectively disabled with SchemaConfiguration
- enums of type string/integer/boolean typed using typing.Literal
- mypy static type checking run on generated sample
- Sending/receiving decimals as strings supported with type:string format: number -> DecimalSchema
- Sending/receiving uuids as strings supported with type:string format: uuid -> UUIDSchema
- quicker load time for python modules (a single endpoint can be imported and used without loading others)
- composed schemas with type constraints supported (type:object + oneOf/anyOf/allOf)
- schemas are not coerced/cast. For example string + date are both stored as string, and there is a date accessor

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
generateSourceCodeOnly Specifies that only a library source code is to be generated. false
hideGenerationTimestamp Hides the generation timestamp when files are generated. true
nonCompliantUseDiscriminatorIfCompositionFails When true, If the payload fails to validate against composed schemas (allOf/anyOf/oneOf/not) and a discriminator is present, then ignore the composition validation errors and attempt to use the discriminator to validate the payload.
Note: setting this to true makes the generated client not comply with json schema because it ignores composition validation errors. Please consider making your schemas more restrictive rather than setting this to true. You can do that by:
  • defining the propertyName as an enum with only one value in the schemas that are in your discriminator map
  • setting additionalProperties: false in your schemas
true
If composition fails and a discriminator exists, the composition errors will be ignored and validation will be attempted with the discriminator
false
Composition validation must succeed. Discriminator validation must succeed.
 false
packageUrl python package URL. null
packageVersion python package version. 1.0.0
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
useNose use the nose test framework false

SUPPORTED VENDOR EXTENSIONS

Extension name Description Applicable for Default value
x-enum-varnames A list of strings that defines the enum variable names, must be adjacent to enum SCHEMA []
x-enum-descriptions A list of strings that defines the enum descriptions, must be adjacent to enum SCHEMA []

INSTANTIATION TYPES

Type/Alias Instantiated By
array tuple
boolean bool
integer int
null None
number typing.Union[float, int]
object immutabledict.immutabledict
string str

LANGUAGE PRIMITIVES

  • None
  • bool
  • bytes
  • date
  • datetime
  • dict
  • file
  • float
  • int
  • list
  • object
  • str

RESERVED WORDS

  • @property
  • and
  • as
  • assert
  • async
  • await
  • bool
  • break
  • class
  • continue
  • cookie_params
  • datetime
  • decimal
  • def
  • del
  • dict
  • elif
  • else
  • except
  • exec
  • false
  • finally
  • float
  • for
  • from
  • functools
  • global
  • header_params
  • if
  • immutabledict
  • import
  • in
  • int
  • io
  • is
  • lambda
  • list
  • none
  • nonlocal
  • not
  • or
  • pass
  • path_params
  • print
  • property
  • query_params
  • raise
  • re
  • resource_path
  • return
  • schemas
  • self
  • str
  • true
  • try
  • tuple
  • typing
  • typing_extensions
  • uuid
  • while
  • with
  • yield

FEATURE SET

Client Modification Feature

Name Supported Defined By
BasePath ✗ ToolingExtension
Authorizations ✗ ToolingExtension
UserAgent ✗ ToolingExtension
MockServer ✗ ToolingExtension

Components Feature

Name Supported Defined By
schemas ✓ OAS3
responses ✓ OAS3
parameters ✓ OAS3
examples ✗ OAS3
requestBodies ✓ OAS3
headers ✓ OAS3
securitySchemes ✓ OAS3
links ✗ OAS3
callbacks ✗ OAS3
pathItems ✗ OAS3

Data Type Feature

Name Supported Defined By
Custom ✗ OAS2,OAS3
Int32 ✓ OAS2,OAS3
Int64 ✓ OAS2,OAS3
Integer ✓ OAS2,OAS3
Float ✓ OAS2,OAS3
Double ✓ OAS2,OAS3
Number ✓ OAS2,OAS3
String ✓ OAS2,OAS3
Byte ✗ OAS2,OAS3
Binary ✓ OAS2,OAS3
Boolean ✓ OAS2,OAS3
Date ✓ OAS2,OAS3
DateTime ✓ OAS2,OAS3
Password ✗ OAS2,OAS3
File ✓ OAS2
Uuid ✓ OAS2,OAS3
Array ✓ OAS2,OAS3
Null ✓ OAS3
AnyType ✓ OAS2,OAS3
Object ✓ OAS2,OAS3
Enum ✓ OAS2,OAS3

Documentation Feature

Name Supported Defined By
Readme ✓ ToolingExtension
Servers ✓ OAS3
Security ✓ OAS2,OAS3
ComponentSchemas ✓ OAS3
ComponentResponses ✓ OAS3
ComponentParameters ✓ OAS3
ComponentRequestBodies ✓ OAS3
ComponentHeaders ✓ OAS3
ComponentSecuritySchemes ✓ OAS3
ComponentLinks ✗ OAS3
ComponentCallbacks ✗ OAS3
ComponentPathItems ✗ OAS3
Api ✓ ToolingExtension

Global Feature

Name Supported Defined By
Info ✓ OAS2,OAS3
Servers ✓ OAS3
Paths ✓ OAS2,OAS3
Webhooks ✗ OAS3
Components ✓ OAS3
Security ✓ OAS2,OAS3
Tags ✓ OAS2,OAS3
ExternalDocs ✗ OAS2,OAS3

Operation Feature

Name Supported Defined By
Responses_HttpStatusCode ✓ OAS3
Responses_RangedResponseCodes ✓ OAS3
Responses_Default ✓ OAS3
Responses_RedirectionResponse ✓ OAS3
Security ✓ OAS2,OAS3
Servers ✓ OAS3

Parameter Feature

Name Supported Defined By
Name ✓ OAS2,OAS3
Required ✓ OAS2,OAS3
In_Path ✓ OAS2,OAS3
In_Query ✓ OAS2,OAS3
In_Header ✓ OAS2,OAS3
In_Cookie ✗ OAS3
Style_Matrix ✓ OAS3
Style_Label ✓ OAS3
Style_Form ✓ OAS3
Style_Simple ✓ OAS3
Style_SpaceDelimited ✓ OAS3
Style_PipeDelimited ✓ OAS3
Style_DeepObject ✗ OAS3
Explode ✓ OAS3
Schema ✓ OAS3
Content ✓ OAS3

Schema Feature

Name Supported Defined By
AdditionalProperties ✓ OAS2,OAS3
AllOf ✓ OAS2,OAS3
AnyOf ✓ OAS3
Const ✓ OAS3
Contains ✓ OAS3
Default ✓ OAS2,OAS3
DependentRequired ✓ OAS3
DependentSchemas ✓ OAS3
Discriminator ✓ OAS2,OAS3
Else ✓ OAS3
Enum ✓ OAS2,OAS3
ExclusiveMinimum ✓ OAS2,OAS3
ExclusiveMaximum ✓ OAS2,OAS3
Format ✓ OAS2,OAS3
If ✓ OAS3
Items ✓ OAS2,OAS3
MaxContains ✓ OAS3
MaxItems ✓ OAS2,OAS3
MaxLength ✓ OAS2,OAS3
MaxProperties ✓ OAS2,OAS3
Maximum ✓ OAS2,OAS3
MinContains ✓ OAS3
MinItems ✓ OAS2,OAS3
MinLength ✓ OAS2,OAS3
MinProperties ✓ OAS2,OAS3
Minimum ✓ OAS2,OAS3
MultipleOf ✓ OAS2,OAS3
Not ✓ OAS3
Nullable ✓ OAS3
OneOf ✓ OAS3
Pattern ✓ OAS2,OAS3
PatternProperties ✓ OAS3
PrefixItems ✓ OAS3
Properties ✓ OAS2,OAS3
PropertyNames ✓ OAS3
Ref ✓ OAS2,OAS3
Required ✓ OAS2,OAS3
Then ✓ OAS3
Type ✓ OAS2,OAS3
UnevaluatedItems ✓ OAS3
UnevaluatedProperties ✓ OAS3
UniqueItems ✓ OAS2,OAS3
Xml ✗ OAS2,OAS3

Security Feature

Name Supported Defined By
HTTP_Basic ✓ OAS2,OAS3
ApiKey ✓ OAS2,OAS3
OpenIDConnect ✗ OAS3
HTTP_Bearer ✓ OAS2,OAS3
OAuth2_Implicit ✗ OAS2,OAS3
OAuth2_Password ✗ OAS2,OAS3
OAuth2_ClientCredentials ✗ OAS2,OAS3
OAuth2_AuthorizationCode ✗ OAS2,OAS3

Wire Format Feature

Name Supported Defined By
JSON ✓ OAS2,OAS3
XML ✗ OAS2,OAS3
PROTOBUF ✗ ToolingExtension
Custom ✓ OAS2,OAS3