self,
*,
debug: bool = False,
- routes: List[BaseRoute] = None,
+ routes: Optional[List[BaseRoute]] = None,
title: str = "FastAPI",
description: str = "",
version: str = "0.1.0",
redoc_url: Optional[str] = "/redoc",
swagger_ui_oauth2_redirect_url: Optional[str] = "/docs/oauth2-redirect",
swagger_ui_init_oauth: Optional[dict] = None,
- middleware: Sequence[Middleware] = None,
- exception_handlers: Dict[Union[int, Type[Exception]], Callable] = None,
- on_startup: Sequence[Callable] = None,
- on_shutdown: Sequence[Callable] = None,
+ middleware: Optional[Sequence[Middleware]] = None,
+ exception_handlers: Optional[
+ Dict[Union[int, Type[Exception]], Callable]
+ ] = None,
+ on_startup: Optional[Sequence[Callable]] = None,
+ on_shutdown: Optional[Sequence[Callable]] = None,
openapi_prefix: str = "",
root_path: str = "",
root_path_in_servers: bool = True,
path: str,
endpoint: Callable,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- methods: List[str] = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ methods: Optional[List[str]] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
) -> None:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- methods: List[str] = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ methods: Optional[List[str]] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
return decorator
def add_api_websocket_route(
- self, path: str, endpoint: Callable, name: str = None
+ self, path: str, endpoint: Callable, name: Optional[str] = None
) -> None:
self.router.add_api_websocket_route(path, endpoint, name=name)
- def websocket(self, path: str, name: str = None) -> Callable:
+ def websocket(self, path: str, name: Optional[str] = None) -> Callable:
def decorator(func: Callable) -> Callable:
self.add_api_websocket_route(path, func, name=name)
return func
router: routing.APIRouter,
*,
prefix: str = "",
- tags: List[str] = None,
- dependencies: Sequence[Depends] = None,
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[Depends]] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
default_response_class: Optional[Type[Response]] = None,
) -> None:
self.router.include_router(
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[routing.APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[routing.APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[routing.APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[routing.APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[routing.APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[routing.APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[routing.APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[routing.APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[routing.APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[routing.APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[routing.APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[routing.APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[routing.APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[routing.APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[routing.APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[routing.APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
-from typing import Callable, List, Sequence
+from typing import Callable, List, Optional, Sequence
from fastapi.security.base import SecurityBase
class SecurityRequirement:
- def __init__(self, security_scheme: SecurityBase, scopes: Sequence[str] = None):
+ def __init__(
+ self, security_scheme: SecurityBase, scopes: Optional[Sequence[str]] = None
+ ):
self.security_scheme = security_scheme
self.scopes = scopes
def __init__(
self,
*,
- path_params: List[ModelField] = None,
- query_params: List[ModelField] = None,
- header_params: List[ModelField] = None,
- cookie_params: List[ModelField] = None,
- body_params: List[ModelField] = None,
- dependencies: List["Dependant"] = None,
- security_schemes: List[SecurityRequirement] = None,
- name: str = None,
- call: Callable = None,
- request_param_name: str = None,
- websocket_param_name: str = None,
- response_param_name: str = None,
- background_tasks_param_name: str = None,
- security_scopes_param_name: str = None,
- security_scopes: List[str] = None,
+ path_params: Optional[List[ModelField]] = None,
+ query_params: Optional[List[ModelField]] = None,
+ header_params: Optional[List[ModelField]] = None,
+ cookie_params: Optional[List[ModelField]] = None,
+ body_params: Optional[List[ModelField]] = None,
+ dependencies: Optional[List["Dependant"]] = None,
+ security_schemes: Optional[List[SecurityRequirement]] = None,
+ name: Optional[str] = None,
+ call: Optional[Callable] = None,
+ request_param_name: Optional[str] = None,
+ websocket_param_name: Optional[str] = None,
+ response_param_name: Optional[str] = None,
+ background_tasks_param_name: Optional[str] = None,
+ security_scopes_param_name: Optional[str] = None,
+ security_scopes: Optional[List[str]] = None,
use_cache: bool = True,
- path: str = None,
+ path: Optional[str] = None,
) -> None:
self.path_params = path_params or []
self.query_params = query_params or []
def get_param_sub_dependant(
- *, param: inspect.Parameter, path: str, security_scopes: List[str] = None
+ *, param: inspect.Parameter, path: str, security_scopes: Optional[List[str]] = None
) -> Dependant:
depends: params.Depends = param.default
if depends.dependency:
depends: params.Depends,
dependency: Callable,
path: str,
- name: str = None,
- security_scopes: List[str] = None,
+ name: Optional[str] = None,
+ security_scopes: Optional[List[str]] = None,
) -> Dependant:
security_requirement = None
security_scopes = security_scopes or []
def get_flat_dependant(
- dependant: Dependant, *, skip_repeats: bool = False, visited: List[CacheKey] = None
+ dependant: Dependant,
+ *,
+ skip_repeats: bool = False,
+ visited: Optional[List[CacheKey]] = None,
) -> Dependant:
if visited is None:
visited = []
*,
path: str,
call: Callable,
- name: str = None,
- security_scopes: List[str] = None,
+ name: Optional[str] = None,
+ security_scopes: Optional[List[str]] = None,
use_cache: bool = True,
) -> Dependant:
path_param_names = get_path_param_names(path)
param: inspect.Parameter,
param_name: str,
default_field_info: Type[params.Param] = params.Param,
- force_type: params.ParamTypes = None,
+ force_type: Optional[params.ParamTypes] = None,
ignore_default: bool = False,
) -> ModelField:
default_value = Required
request: Union[Request, WebSocket],
dependant: Dependant,
body: Optional[Union[Dict[str, Any], FormData]] = None,
- background_tasks: BackgroundTasks = None,
- response: Response = None,
- dependency_overrides_provider: Any = None,
- dependency_cache: Dict[Tuple[Callable, Tuple[str]], Any] = None,
+ background_tasks: Optional[BackgroundTasks] = None,
+ response: Optional[Response] = None,
+ dependency_overrides_provider: Optional[Any] = None,
+ dependency_cache: Optional[Dict[Tuple[Callable, Tuple[str]], Any]] = None,
) -> Tuple[
Dict[str, Any],
List[ErrorWrapper],
else:
loc = ("body", field.alias)
- value: Any = None
+ value: Optional[Any] = None
if received_body is not None:
if (
field.shape in sequence_shapes or field.type_ in sequence_types
from enum import Enum
from pathlib import PurePath
from types import GeneratorType
-from typing import Any, Callable, Dict, List, Set, Tuple, Union
+from typing import Any, Callable, Dict, List, Optional, Set, Tuple, Union
from fastapi.logger import logger
from fastapi.utils import PYDANTIC_1
def jsonable_encoder(
obj: Any,
- include: Union[SetIntStr, DictIntStrAny] = None,
+ include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
exclude: Union[SetIntStr, DictIntStrAny] = set(),
by_alias: bool = True,
- skip_defaults: bool = None,
+ skip_defaults: Optional[bool] = None,
exclude_unset: bool = False,
exclude_defaults: bool = False,
exclude_none: bool = False,
-from typing import Any, Sequence
+from typing import Any, Dict, Optional, Sequence
from fastapi.utils import PYDANTIC_1
from pydantic import ValidationError, create_model
class HTTPException(StarletteHTTPException):
def __init__(
- self, status_code: int, detail: Any = None, headers: dict = None
+ self,
+ status_code: int,
+ detail: Any = None,
+ headers: Optional[Dict[str, Any]] = None,
) -> None:
super().__init__(status_code=status_code, detail=detail)
self.headers = headers
title: str,
version: str,
openapi_version: str = "3.0.2",
- description: str = None,
+ description: Optional[str] = None,
routes: Sequence[BaseRoute],
tags: Optional[List[Dict[str, Any]]] = None,
servers: Optional[List[Dict[str, Union[str, Any]]]] = None,
-from typing import Any, Callable, Sequence
+from typing import Any, Callable, Optional, Sequence
from fastapi import params
def Path( # noqa: N802
default: Any,
*,
- alias: str = None,
- title: str = None,
- description: str = None,
- gt: float = None,
- ge: float = None,
- lt: float = None,
- le: float = None,
- min_length: int = None,
- max_length: int = None,
- regex: str = None,
- deprecated: bool = None,
+ alias: Optional[str] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ regex: Optional[str] = None,
+ deprecated: Optional[bool] = None,
**extra: Any,
) -> Any:
return params.Path(
def Query( # noqa: N802
default: Any,
*,
- alias: str = None,
- title: str = None,
- description: str = None,
- gt: float = None,
- ge: float = None,
- lt: float = None,
- le: float = None,
- min_length: int = None,
- max_length: int = None,
- regex: str = None,
- deprecated: bool = None,
+ alias: Optional[str] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ regex: Optional[str] = None,
+ deprecated: Optional[bool] = None,
**extra: Any,
) -> Any:
return params.Query(
def Header( # noqa: N802
default: Any,
*,
- alias: str = None,
+ alias: Optional[str] = None,
convert_underscores: bool = True,
- title: str = None,
- description: str = None,
- gt: float = None,
- ge: float = None,
- lt: float = None,
- le: float = None,
- min_length: int = None,
- max_length: int = None,
- regex: str = None,
- deprecated: bool = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ regex: Optional[str] = None,
+ deprecated: Optional[bool] = None,
**extra: Any,
) -> Any:
return params.Header(
def Cookie( # noqa: N802
default: Any,
*,
- alias: str = None,
- title: str = None,
- description: str = None,
- gt: float = None,
- ge: float = None,
- lt: float = None,
- le: float = None,
- min_length: int = None,
- max_length: int = None,
- regex: str = None,
- deprecated: bool = None,
+ alias: Optional[str] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ regex: Optional[str] = None,
+ deprecated: Optional[bool] = None,
**extra: Any,
) -> Any:
return params.Cookie(
*,
embed: bool = False,
media_type: str = "application/json",
- alias: str = None,
- title: str = None,
- description: str = None,
- gt: float = None,
- ge: float = None,
- lt: float = None,
- le: float = None,
- min_length: int = None,
- max_length: int = None,
- regex: str = None,
+ alias: Optional[str] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ regex: Optional[str] = None,
**extra: Any,
) -> Any:
return params.Body(
default: Any,
*,
media_type: str = "application/x-www-form-urlencoded",
- alias: str = None,
- title: str = None,
- description: str = None,
- gt: float = None,
- ge: float = None,
- lt: float = None,
- le: float = None,
- min_length: int = None,
- max_length: int = None,
- regex: str = None,
+ alias: Optional[str] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ regex: Optional[str] = None,
**extra: Any,
) -> Any:
return params.Form(
default: Any,
*,
media_type: str = "multipart/form-data",
- alias: str = None,
- title: str = None,
- description: str = None,
- gt: float = None,
- ge: float = None,
- lt: float = None,
- le: float = None,
- min_length: int = None,
- max_length: int = None,
- regex: str = None,
+ alias: Optional[str] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ regex: Optional[str] = None,
**extra: Any,
) -> Any:
return params.File(
def Depends( # noqa: N802
- dependency: Callable = None, *, use_cache: bool = True
+ dependency: Optional[Callable] = None, *, use_cache: bool = True
) -> Any:
return params.Depends(dependency=dependency, use_cache=use_cache)
def Security( # noqa: N802
- dependency: Callable = None, *, scopes: Sequence[str] = None, use_cache: bool = True
+ dependency: Optional[Callable] = None,
+ *,
+ scopes: Optional[Sequence[str]] = None,
+ use_cache: bool = True,
) -> Any:
return params.Security(dependency=dependency, scopes=scopes, use_cache=use_cache)
from enum import Enum
-from typing import Any, Callable, Sequence
+from typing import Any, Callable, Optional, Sequence
try:
from pydantic.fields import FieldInfo
self,
default: Any,
*,
- alias: str = None,
- title: str = None,
- description: str = None,
- gt: float = None,
- ge: float = None,
- lt: float = None,
- le: float = None,
- min_length: int = None,
- max_length: int = None,
- regex: str = None,
- deprecated: bool = None,
+ alias: Optional[str] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ regex: Optional[str] = None,
+ deprecated: Optional[bool] = None,
**extra: Any,
):
self.deprecated = deprecated
self,
default: Any,
*,
- alias: str = None,
- title: str = None,
- description: str = None,
- gt: float = None,
- ge: float = None,
- lt: float = None,
- le: float = None,
- min_length: int = None,
- max_length: int = None,
- regex: str = None,
- deprecated: bool = None,
+ alias: Optional[str] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ regex: Optional[str] = None,
+ deprecated: Optional[bool] = None,
**extra: Any,
):
self.in_ = self.in_
self,
default: Any,
*,
- alias: str = None,
- title: str = None,
- description: str = None,
- gt: float = None,
- ge: float = None,
- lt: float = None,
- le: float = None,
- min_length: int = None,
- max_length: int = None,
- regex: str = None,
- deprecated: bool = None,
+ alias: Optional[str] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ regex: Optional[str] = None,
+ deprecated: Optional[bool] = None,
**extra: Any,
):
super().__init__(
self,
default: Any,
*,
- alias: str = None,
+ alias: Optional[str] = None,
convert_underscores: bool = True,
- title: str = None,
- description: str = None,
- gt: float = None,
- ge: float = None,
- lt: float = None,
- le: float = None,
- min_length: int = None,
- max_length: int = None,
- regex: str = None,
- deprecated: bool = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ regex: Optional[str] = None,
+ deprecated: Optional[bool] = None,
**extra: Any,
):
self.convert_underscores = convert_underscores
self,
default: Any,
*,
- alias: str = None,
- title: str = None,
- description: str = None,
- gt: float = None,
- ge: float = None,
- lt: float = None,
- le: float = None,
- min_length: int = None,
- max_length: int = None,
- regex: str = None,
- deprecated: bool = None,
+ alias: Optional[str] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ regex: Optional[str] = None,
+ deprecated: Optional[bool] = None,
**extra: Any,
):
super().__init__(
*,
embed: bool = False,
media_type: str = "application/json",
- alias: str = None,
- title: str = None,
- description: str = None,
- gt: float = None,
- ge: float = None,
- lt: float = None,
- le: float = None,
- min_length: int = None,
- max_length: int = None,
- regex: str = None,
+ alias: Optional[str] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ regex: Optional[str] = None,
**extra: Any,
):
self.embed = embed
default: Any,
*,
media_type: str = "application/x-www-form-urlencoded",
- alias: str = None,
- title: str = None,
- description: str = None,
- gt: float = None,
- ge: float = None,
- lt: float = None,
- le: float = None,
- min_length: int = None,
- max_length: int = None,
- regex: str = None,
+ alias: Optional[str] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ regex: Optional[str] = None,
**extra: Any,
):
super().__init__(
default: Any,
*,
media_type: str = "multipart/form-data",
- alias: str = None,
- title: str = None,
- description: str = None,
- gt: float = None,
- ge: float = None,
- lt: float = None,
- le: float = None,
- min_length: int = None,
- max_length: int = None,
- regex: str = None,
+ alias: Optional[str] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ regex: Optional[str] = None,
**extra: Any,
):
super().__init__(
class Depends:
- def __init__(self, dependency: Callable = None, *, use_cache: bool = True):
+ def __init__(
+ self, dependency: Optional[Callable] = None, *, use_cache: bool = True
+ ):
self.dependency = dependency
self.use_cache = use_cache
class Security(Depends):
def __init__(
self,
- dependency: Callable = None,
+ dependency: Optional[Callable] = None,
*,
- scopes: Sequence[str] = None,
+ scopes: Optional[Sequence[str]] = None,
use_cache: bool = True,
):
super().__init__(dependency=dependency, use_cache=use_cache)
async def serialize_response(
*,
- field: ModelField = None,
+ field: Optional[ModelField] = None,
response_content: Any,
- include: Union[SetIntStr, DictIntStrAny] = None,
+ include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
exclude: Union[SetIntStr, DictIntStrAny] = set(),
by_alias: bool = True,
exclude_unset: bool = False,
def get_request_handler(
dependant: Dependant,
- body_field: ModelField = None,
+ body_field: Optional[ModelField] = None,
status_code: int = 200,
response_class: Type[Response] = JSONResponse,
- response_field: ModelField = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ response_field: Optional[ModelField] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
- dependency_overrides_provider: Any = None,
+ dependency_overrides_provider: Optional[Any] = None,
) -> Callable:
assert dependant.call is not None, "dependant.call must be a function"
is_coroutine = asyncio.iscoroutinefunction(dependant.call)
def get_websocket_app(
- dependant: Dependant, dependency_overrides_provider: Any = None
+ dependant: Dependant, dependency_overrides_provider: Optional[Any] = None
) -> Callable:
async def app(websocket: WebSocket) -> None:
solved_result = await solve_dependencies(
path: str,
endpoint: Callable,
*,
- name: str = None,
- dependency_overrides_provider: Any = None,
+ name: Optional[str] = None,
+ dependency_overrides_provider: Optional[Any] = None,
) -> None:
self.path = path
self.endpoint = endpoint
path: str,
endpoint: Callable,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[params.Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[params.Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- name: str = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ name: Optional[str] = None,
methods: Optional[Union[Set[str], List[str]]] = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
response_model_exclude_unset: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
response_class: Optional[Type[Response]] = None,
- dependency_overrides_provider: Any = None,
+ dependency_overrides_provider: Optional[Any] = None,
callbacks: Optional[List["APIRoute"]] = None,
) -> None:
# normalise enums e.g. http.HTTPStatus
class APIRouter(routing.Router):
def __init__(
self,
- routes: List[routing.BaseRoute] = None,
+ routes: Optional[List[routing.BaseRoute]] = None,
redirect_slashes: bool = True,
- default: ASGIApp = None,
- dependency_overrides_provider: Any = None,
+ default: Optional[ASGIApp] = None,
+ dependency_overrides_provider: Optional[Any] = None,
route_class: Type[APIRoute] = APIRoute,
- default_response_class: Type[Response] = None,
- on_startup: Sequence[Callable] = None,
- on_shutdown: Sequence[Callable] = None,
+ default_response_class: Optional[Type[Response]] = None,
+ on_startup: Optional[Sequence[Callable]] = None,
+ on_shutdown: Optional[Sequence[Callable]] = None,
) -> None:
super().__init__(
routes=routes,
path: str,
endpoint: Callable,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[params.Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[params.Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
methods: Optional[Union[Set[str], List[str]]] = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
route_class_override: Optional[Type[APIRoute]] = None,
- callbacks: List[APIRoute] = None,
+ callbacks: Optional[List[APIRoute]] = None,
) -> None:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[params.Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[params.Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- methods: List[str] = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ methods: Optional[List[str]] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
return decorator
def add_api_websocket_route(
- self, path: str, endpoint: Callable, name: str = None
+ self, path: str, endpoint: Callable, name: Optional[str] = None
) -> None:
route = APIWebSocketRoute(
path,
)
self.routes.append(route)
- def websocket(self, path: str, name: str = None) -> Callable:
+ def websocket(self, path: str, name: Optional[str] = None) -> Callable:
def decorator(func: Callable) -> Callable:
self.add_api_websocket_route(path, func, name=name)
return func
router: "APIRouter",
*,
prefix: str = "",
- tags: List[str] = None,
- dependencies: Sequence[params.Depends] = None,
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[params.Depends]] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
default_response_class: Optional[Type[Response]] = None,
) -> None:
if prefix:
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[params.Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[params.Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[params.Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[params.Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[params.Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[params.Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[params.Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[params.Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[params.Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[params.Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[params.Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[params.Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[params.Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[params.Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
self,
path: str,
*,
- response_model: Type[Any] = None,
+ response_model: Optional[Type[Any]] = None,
status_code: int = 200,
- tags: List[str] = None,
- dependencies: Sequence[params.Depends] = None,
- summary: str = None,
- description: str = None,
+ tags: Optional[List[str]] = None,
+ dependencies: Optional[Sequence[params.Depends]] = None,
+ summary: Optional[str] = None,
+ description: Optional[str] = None,
response_description: str = "Successful Response",
- responses: Dict[Union[int, str], Dict[str, Any]] = None,
- deprecated: bool = None,
- operation_id: str = None,
- response_model_include: Union[SetIntStr, DictIntStrAny] = None,
+ responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+ deprecated: Optional[bool] = None,
+ operation_id: Optional[str] = None,
+ response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),
response_model_by_alias: bool = True,
- response_model_skip_defaults: bool = None,
+ response_model_skip_defaults: Optional[bool] = None,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
- response_class: Type[Response] = None,
- name: str = None,
- callbacks: List[APIRoute] = None,
+ response_class: Optional[Type[Response]] = None,
+ name: Optional[str] = None,
+ callbacks: Optional[List[APIRoute]] = None,
) -> Callable:
if response_model_skip_defaults is not None:
warning_response_model_skip_defaults_deprecated() # pragma: nocover
class APIKeyQuery(APIKeyBase):
- def __init__(self, *, name: str, scheme_name: str = None, auto_error: bool = True):
+ def __init__(
+ self, *, name: str, scheme_name: Optional[str] = None, auto_error: bool = True
+ ):
self.model: APIKey = APIKey(**{"in": APIKeyIn.query}, name=name)
self.scheme_name = scheme_name or self.__class__.__name__
self.auto_error = auto_error
class APIKeyHeader(APIKeyBase):
- def __init__(self, *, name: str, scheme_name: str = None, auto_error: bool = True):
+ def __init__(
+ self, *, name: str, scheme_name: Optional[str] = None, auto_error: bool = True
+ ):
self.model: APIKey = APIKey(**{"in": APIKeyIn.header}, name=name)
self.scheme_name = scheme_name or self.__class__.__name__
self.auto_error = auto_error
class APIKeyCookie(APIKeyBase):
- def __init__(self, *, name: str, scheme_name: str = None, auto_error: bool = True):
+ def __init__(
+ self, *, name: str, scheme_name: Optional[str] = None, auto_error: bool = True
+ ):
self.model: APIKey = APIKey(**{"in": APIKeyIn.cookie}, name=name)
self.scheme_name = scheme_name or self.__class__.__name__
self.auto_error = auto_error
class HTTPBase(SecurityBase):
def __init__(
- self, *, scheme: str, scheme_name: str = None, auto_error: bool = True
+ self, *, scheme: str, scheme_name: Optional[str] = None, auto_error: bool = True
):
self.model = HTTPBaseModel(scheme=scheme)
self.scheme_name = scheme_name or self.__class__.__name__
class HTTPBasic(HTTPBase):
def __init__(
- self, *, scheme_name: str = None, realm: str = None, auto_error: bool = True
+ self,
+ *,
+ scheme_name: Optional[str] = None,
+ realm: Optional[str] = None,
+ auto_error: bool = True,
):
self.model = HTTPBaseModel(scheme="basic")
self.scheme_name = scheme_name or self.__class__.__name__
def __init__(
self,
*,
- bearerFormat: str = None,
- scheme_name: str = None,
+ bearerFormat: Optional[str] = None,
+ scheme_name: Optional[str] = None,
auto_error: bool = True,
):
self.model = HTTPBearerModel(bearerFormat=bearerFormat)
class HTTPDigest(HTTPBase):
- def __init__(self, *, scheme_name: str = None, auto_error: bool = True):
+ def __init__(self, *, scheme_name: Optional[str] = None, auto_error: bool = True):
self.model = HTTPBaseModel(scheme="digest")
self.scheme_name = scheme_name or self.__class__.__name__
self.auto_error = auto_error
self,
*,
flows: OAuthFlowsModel = OAuthFlowsModel(),
- scheme_name: str = None,
- auto_error: bool = True
+ scheme_name: Optional[str] = None,
+ auto_error: Optional[bool] = True
):
self.model = OAuth2Model(flows=flows)
self.scheme_name = scheme_name or self.__class__.__name__
def __init__(
self,
tokenUrl: str,
- scheme_name: str = None,
- scopes: dict = None,
+ scheme_name: Optional[str] = None,
+ scopes: Optional[dict] = None,
auto_error: bool = True,
):
if not scopes:
self,
authorizationUrl: str,
tokenUrl: str,
- refreshUrl: str = None,
- scheme_name: str = None,
- scopes: dict = None,
+ refreshUrl: Optional[str] = None,
+ scheme_name: Optional[str] = None,
+ scopes: Optional[dict] = None,
auto_error: bool = True,
):
if not scopes:
class SecurityScopes:
- def __init__(self, scopes: List[str] = None):
+ def __init__(self, scopes: Optional[List[str]] = None):
self.scopes = scopes or []
self.scope_str = " ".join(self.scopes)
class OpenIdConnect(SecurityBase):
def __init__(
- self, *, openIdConnectUrl: str, scheme_name: str = None, auto_error: bool = True
+ self,
+ *,
+ openIdConnectUrl: str,
+ scheme_name: Optional[str] = None,
+ auto_error: bool = True
):
self.model = OpenIdConnectModel(openIdConnectUrl=openIdConnectUrl)
self.scheme_name = scheme_name or self.__class__.__name__
def create_cloned_field(
- field: ModelField, *, cloned_types: Dict[Type[BaseModel], Type[BaseModel]] = None,
+ field: ModelField,
+ *,
+ cloned_types: Optional[Dict[Type[BaseModel], Type[BaseModel]]] = None,
) -> ModelField:
# _cloned_types has already cloned types, to support recursive models
if cloned_types is None:
class Item(BaseModel):
name: str
price: Optional[float] = None
- owner_ids: List[int] = None
+ owner_ids: Optional[List[int]] = None
@app.get("/items/valid", response_model=Item)
class Item:
name: str
price: Optional[float] = None
- owner_ids: List[int] = None
+ owner_ids: Optional[List[int]] = None
@app.get("/items/valid", response_model=Item)
class Item(BaseModel):
name: str = Field(..., alias="aliased_name")
price: Optional[float] = None
- owner_ids: List[int] = None
+ owner_ids: Optional[List[int]] = None
@app.get("/items/valid", response_model=Item)
class Item(BaseModel):
name: str
price: Optional[float] = None
- owner_ids: List[int] = None
+ owner_ids: Optional[List[int]] = None
@app.get("/items/invalid", response_model=Item)
class Item:
name: str
price: Optional[float] = None
- owner_ids: List[int] = None
+ owner_ids: Optional[List[int]] = None
@app.get("/items/invalid", response_model=Item)