happyz
/
fastapi
mirror of https://github.com/tiangolo/fastapi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

♻️ Simplify Pydantic configs in OpenAPI models in `fastapi/openapi/models.py` (#10886) 

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
This commit is contained in:
Paul 2024-04-18 18:49:33 -04:00 committed by GitHub
parent 5815fa58fb
commit 74cc33d16b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 32 additions and 198 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

230
fastapi/openapi/models.py
View File

@ -55,35 +55,29 @@ except ImportError: # pragma: no cover
return with_info_plain_validator_function(cls._validate) return with_info_plain_validator_function(cls._validate)
class Contact(BaseModel): class BaseModelWithConfig(BaseModel):
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else:
class Config:
extra = "allow"
class Contact(BaseModelWithConfig):
name: Optional[str] = None name: Optional[str] = None
url: Optional[AnyUrl] = None url: Optional[AnyUrl] = None
email: Optional[EmailStr] = None email: Optional[EmailStr] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else: class License(BaseModelWithConfig):
class Config:
extra = "allow"
class License(BaseModel):
name: str name: str
identifier: Optional[str] = None identifier: Optional[str] = None
url: Optional[AnyUrl] = None url: Optional[AnyUrl] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else: class Info(BaseModelWithConfig):
class Config:
extra = "allow"
class Info(BaseModel):
title: str title: str
summary: Optional[str] = None summary: Optional[str] = None
description: Optional[str] = None description: Optional[str] = None
@ -92,42 +86,18 @@ class Info(BaseModel):
license: Optional[License] = None license: Optional[License] = None
version: str version: str
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else: class ServerVariable(BaseModelWithConfig):
class Config:
extra = "allow"
class ServerVariable(BaseModel):
enum: Annotated[Optional[List[str]], Field(min_length=1)] = None enum: Annotated[Optional[List[str]], Field(min_length=1)] = None
default: str default: str
description: Optional[str] = None description: Optional[str] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else: class Server(BaseModelWithConfig):
class Config:
extra = "allow"
class Server(BaseModel):
url: Union[AnyUrl, str] url: Union[AnyUrl, str]
description: Optional[str] = None description: Optional[str] = None
variables: Optional[Dict[str, ServerVariable]] = None variables: Optional[Dict[str, ServerVariable]] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else:
class Config:
extra = "allow"
class Reference(BaseModel): class Reference(BaseModel):
ref: str = Field(alias="$ref") ref: str = Field(alias="$ref")
@ -138,36 +108,20 @@ class Discriminator(BaseModel):
mapping: Optional[Dict[str, str]] = None mapping: Optional[Dict[str, str]] = None
class XML(BaseModel): class XML(BaseModelWithConfig):
name: Optional[str] = None name: Optional[str] = None
namespace: Optional[str] = None namespace: Optional[str] = None
prefix: Optional[str] = None prefix: Optional[str] = None
attribute: Optional[bool] = None attribute: Optional[bool] = None
wrapped: Optional[bool] = None wrapped: Optional[bool] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else: class ExternalDocumentation(BaseModelWithConfig):
class Config:
extra = "allow"
class ExternalDocumentation(BaseModel):
description: Optional[str] = None description: Optional[str] = None
url: AnyUrl url: AnyUrl
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else: class Schema(BaseModelWithConfig):
class Config:
extra = "allow"
class Schema(BaseModel):
# Ref: JSON Schema 2020-12: https://json-schema.org/draft/2020-12/json-schema-core.html#name-the-json-schema-core-vocabu # Ref: JSON Schema 2020-12: https://json-schema.org/draft/2020-12/json-schema-core.html#name-the-json-schema-core-vocabu
# Core Vocabulary # Core Vocabulary
schema_: Optional[str] = Field(default=None, alias="$schema") schema_: Optional[str] = Field(default=None, alias="$schema")
@ -253,14 +207,6 @@ class Schema(BaseModel):
), ),
] = None ] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else:
class Config:
extra = "allow"
# Ref: https://json-schema.org/draft/2020-12/json-schema-core.html#name-json-schema-documents # Ref: https://json-schema.org/draft/2020-12/json-schema-core.html#name-json-schema-documents
# A JSON Schema MUST be an object or a boolean. # A JSON Schema MUST be an object or a boolean.
@ -289,38 +235,22 @@ class ParameterInType(Enum):
cookie = "cookie" cookie = "cookie"
class Encoding(BaseModel): class Encoding(BaseModelWithConfig):
contentType: Optional[str] = None contentType: Optional[str] = None
headers: Optional[Dict[str, Union["Header", Reference]]] = None headers: Optional[Dict[str, Union["Header", Reference]]] = None
style: Optional[str] = None style: Optional[str] = None
explode: Optional[bool] = None explode: Optional[bool] = None
allowReserved: Optional[bool] = None allowReserved: Optional[bool] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else: class MediaType(BaseModelWithConfig):
class Config:
extra = "allow"
class MediaType(BaseModel):
schema_: Optional[Union[Schema, Reference]] = Field(default=None, alias="schema") schema_: Optional[Union[Schema, Reference]] = Field(default=None, alias="schema")
example: Optional[Any] = None example: Optional[Any] = None
examples: Optional[Dict[str, Union[Example, Reference]]] = None examples: Optional[Dict[str, Union[Example, Reference]]] = None
encoding: Optional[Dict[str, Encoding]] = None encoding: Optional[Dict[str, Encoding]] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else: class ParameterBase(BaseModelWithConfig):
class Config:
extra = "allow"
class ParameterBase(BaseModel):
description: Optional[str] = None description: Optional[str] = None
required: Optional[bool] = None required: Optional[bool] = None
deprecated: Optional[bool] = None deprecated: Optional[bool] = None
@ -334,14 +264,6 @@ class ParameterBase(BaseModel):
# Serialization rules for more complex scenarios # Serialization rules for more complex scenarios
content: Optional[Dict[str, MediaType]] = None content: Optional[Dict[str, MediaType]] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else:
class Config:
extra = "allow"
class Parameter(ParameterBase): class Parameter(ParameterBase):
name: str name: str
@ -352,21 +274,13 @@ class Header(ParameterBase):
pass pass
class RequestBody(BaseModel): class RequestBody(BaseModelWithConfig):
description: Optional[str] = None description: Optional[str] = None
content: Dict[str, MediaType] content: Dict[str, MediaType]
required: Optional[bool] = None required: Optional[bool] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else: class Link(BaseModelWithConfig):
class Config:
extra = "allow"
class Link(BaseModel):
operationRef: Optional[str] = None operationRef: Optional[str] = None
operationId: Optional[str] = None operationId: Optional[str] = None
parameters: Optional[Dict[str, Union[Any, str]]] = None parameters: Optional[Dict[str, Union[Any, str]]] = None
@ -374,31 +288,15 @@ class Link(BaseModel):
description: Optional[str] = None description: Optional[str] = None
server: Optional[Server] = None server: Optional[Server] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else: class Response(BaseModelWithConfig):
class Config:
extra = "allow"
class Response(BaseModel):
description: str description: str
headers: Optional[Dict[str, Union[Header, Reference]]] = None headers: Optional[Dict[str, Union[Header, Reference]]] = None
content: Optional[Dict[str, MediaType]] = None content: Optional[Dict[str, MediaType]] = None
links: Optional[Dict[str, Union[Link, Reference]]] = None links: Optional[Dict[str, Union[Link, Reference]]] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else: class Operation(BaseModelWithConfig):
class Config:
extra = "allow"
class Operation(BaseModel):
tags: Optional[List[str]] = None tags: Optional[List[str]] = None
summary: Optional[str] = None summary: Optional[str] = None
description: Optional[str] = None description: Optional[str] = None
@ -413,16 +311,8 @@ class Operation(BaseModel):
security: Optional[List[Dict[str, List[str]]]] = None security: Optional[List[Dict[str, List[str]]]] = None
servers: Optional[List[Server]] = None servers: Optional[List[Server]] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else: class PathItem(BaseModelWithConfig):
class Config:
extra = "allow"
class PathItem(BaseModel):
ref: Optional[str] = Field(default=None, alias="$ref") ref: Optional[str] = Field(default=None, alias="$ref")
summary: Optional[str] = None summary: Optional[str] = None
description: Optional[str] = None description: Optional[str] = None
@ -437,14 +327,6 @@ class PathItem(BaseModel):
servers: Optional[List[Server]] = None servers: Optional[List[Server]] = None
parameters: Optional[List[Union[Parameter, Reference]]] = None parameters: Optional[List[Union[Parameter, Reference]]] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else:
class Config:
extra = "allow"
class SecuritySchemeType(Enum): class SecuritySchemeType(Enum):
apiKey = "apiKey" apiKey = "apiKey"
@ -453,18 +335,10 @@ class SecuritySchemeType(Enum):
openIdConnect = "openIdConnect" openIdConnect = "openIdConnect"
class SecurityBase(BaseModel): class SecurityBase(BaseModelWithConfig):
type_: SecuritySchemeType = Field(alias="type") type_: SecuritySchemeType = Field(alias="type")
description: Optional[str] = None description: Optional[str] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else:
class Config:
extra = "allow"
class APIKeyIn(Enum): class APIKeyIn(Enum):
query = "query" query = "query"
@ -488,18 +362,10 @@ class HTTPBearer(HTTPBase):
bearerFormat: Optional[str] = None bearerFormat: Optional[str] = None
class OAuthFlow(BaseModel): class OAuthFlow(BaseModelWithConfig):
refreshUrl: Optional[str] = None refreshUrl: Optional[str] = None
scopes: Dict[str, str] = {} scopes: Dict[str, str] = {}
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else:
class Config:
extra = "allow"
class OAuthFlowImplicit(OAuthFlow): class OAuthFlowImplicit(OAuthFlow):
authorizationUrl: str authorizationUrl: str
@ -518,20 +384,12 @@ class OAuthFlowAuthorizationCode(OAuthFlow):
tokenUrl: str tokenUrl: str
class OAuthFlows(BaseModel): class OAuthFlows(BaseModelWithConfig):
implicit: Optional[OAuthFlowImplicit] = None implicit: Optional[OAuthFlowImplicit] = None
password: Optional[OAuthFlowPassword] = None password: Optional[OAuthFlowPassword] = None
clientCredentials: Optional[OAuthFlowClientCredentials] = None clientCredentials: Optional[OAuthFlowClientCredentials] = None
authorizationCode: Optional[OAuthFlowAuthorizationCode] = None authorizationCode: Optional[OAuthFlowAuthorizationCode] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else:
class Config:
extra = "allow"
class OAuth2(SecurityBase): class OAuth2(SecurityBase):
type_: SecuritySchemeType = Field(default=SecuritySchemeType.oauth2, alias="type") type_: SecuritySchemeType = Field(default=SecuritySchemeType.oauth2, alias="type")
@ -548,7 +406,7 @@ class OpenIdConnect(SecurityBase):
SecurityScheme = Union[APIKey, HTTPBase, OAuth2, OpenIdConnect, HTTPBearer] SecurityScheme = Union[APIKey, HTTPBase, OAuth2, OpenIdConnect, HTTPBearer]
class Components(BaseModel): class Components(BaseModelWithConfig):
schemas: Optional[Dict[str, Union[Schema, Reference]]] = None schemas: Optional[Dict[str, Union[Schema, Reference]]] = None
responses: Optional[Dict[str, Union[Response, Reference]]] = None responses: Optional[Dict[str, Union[Response, Reference]]] = None
parameters: Optional[Dict[str, Union[Parameter, Reference]]] = None parameters: Optional[Dict[str, Union[Parameter, Reference]]] = None
@ -561,30 +419,14 @@ class Components(BaseModel):
callbacks: Optional[Dict[str, Union[Dict[str, PathItem], Reference, Any]]] = None callbacks: Optional[Dict[str, Union[Dict[str, PathItem], Reference, Any]]] = None
pathItems: Optional[Dict[str, Union[PathItem, Reference]]] = None pathItems: Optional[Dict[str, Union[PathItem, Reference]]] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else: class Tag(BaseModelWithConfig):
class Config:
extra = "allow"
class Tag(BaseModel):
name: str name: str
description: Optional[str] = None description: Optional[str] = None
externalDocs: Optional[ExternalDocumentation] = None externalDocs: Optional[ExternalDocumentation] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else: class OpenAPI(BaseModelWithConfig):
class Config:
extra = "allow"
class OpenAPI(BaseModel):
openapi: str openapi: str
info: Info info: Info
jsonSchemaDialect: Optional[str] = None jsonSchemaDialect: Optional[str] = None
@ -597,14 +439,6 @@ class OpenAPI(BaseModel):
tags: Optional[List[Tag]] = None tags: Optional[List[Tag]] = None
externalDocs: Optional[ExternalDocumentation] = None externalDocs: Optional[ExternalDocumentation] = None
if PYDANTIC_V2:
model_config = {"extra": "allow"}
else:
class Config:
extra = "allow"
_model_rebuild(Schema) _model_rebuild(Schema)
_model_rebuild(Operation) _model_rebuild(Operation)